GitAuto: [FEATURE] Implement Non Structured Specification API #349
Conversation
![gitauto-ai[bot]](https://avatars.githubusercontent.com/in/844909?s=60&v=4){kind=small}
github-actions
bot
added
the
size/M
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more |
|
Committed the Check Run |
github-actions
bot
added
size/L
|
Committed the Check Run |
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
|
|
Committed the Check Run |
|
Report is too large to display inline. Next stepsMark a package as acceptable riskTo ignore an alert, reply with a comment starting with
|
|
Committed the Check Run |
|
Infisical secrets check: ✅ No secrets leaked! 💻 Scan logs12:37AM INF scanning for exposed secrets...
12:37AM INF 486 commits scanned.
12:37AM INF scan completed in 270ms
12:37AM INF no leaks found
|
gstraccini
bot
added
.NET
![gstraccini[bot]](https://avatars.githubusercontent.com/in/480132?s=60&v=4){kind=small}
gstraccini
bot
added
🚦 awaiting triage
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more |
|
|
✅ Build VTEX-SDK-dotnet 2.3.1504 completed (commit c7826106c7 by @gitauto-ai[bot]) |
guibranco
deleted the
gitauto/issue-51-d427ed0f-0e1f-432d-b8e2-07899216d2ee
branch
Resolves #51
What is the feature
Implement the Non Structured Specification API, allowing users to consult and delete Non Structured Specifications as outlined in the Non Structured Specification documentation.
Why we need the feature
Providing a Non Structured Specification API enhances the catalog management capabilities by allowing developers and users to programmatically access and manage non structured specifications. This facilitates better integration with other systems, automates workflows, and improves overall flexibility in handling product specifications.
How to implement and why
Define API Endpoints:
Reason: Clear and RESTful endpoints make the API intuitive and easy to integrate.
Update the
SrcDirectory:Reason: Maintaining separation of concerns and ensuring robust handling of API operations.
Modify Documentation:
Reason: Providing comprehensive documentation ensures that developers can effectively utilize the new API features.
Write Unit and Integration Tests:
Testsdirectory to cover the new functionality, ensuring reliability and preventing regressions.Reason: Automated testing is essential for maintaining code quality and verifying that the new features work as intended.
Update Configuration Files:
.deepsource.tomlandappveyor.ymlto include any new dependencies or build steps required for the feature.Reason: Ensuring that the development and deployment pipelines are aware of and accommodate the new feature.
About backward compatibility
This feature introduces new API endpoints without altering existing ones, ensuring that current integrations remain unaffected. By adhering to RESTful principles and maintaining the current API structure, we preserve backward compatibility and provide a seamless upgrade path for existing users.
Test these changes locally